Vcenter Ovf DeploymentOptionParams

The Vcenter Ovf DeploymentOptionParams schema describes the possible deployment options as well as the choice provided by the user.

This information based on the ovf:DeploymentOptionSection.

See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy and POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=filter.

JSON Example

{
    "deployment_options": [
        {
            "key": "string",
            "label": "string",
            "description": "string",
            "default_choice": false
        }
    ],
    "selected_key": "string",
    "type": "string"
}

array of Vcenter Ovf DeploymentOption

deployment_options

Optional

List of deployment options. This property corresponds to the ovf:Configuration elements of the ovf:DeploymentOptionSection in the specification. It is a discrete set of intended resource allocation configurations from which one can be selected.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

string

selected_key

Optional

The selected deployment option. Identifies the Vcenter Ovf DeploymentOption in the list in the deployment_options property with a matching value in the Vcenter Ovf DeploymentOption.key property.

This property is optional in the input parameters when deploying an OVF package. If missing or null the server will use the default deployment configuration, usually it's the first one in Vcenter Ovf DeploymentOptionParams.deployment_options list. This property is optional in the result when retrieving information about an OVF package. The value will be set only if it is specified with the optional ovf:default attribute.

string

type

Optional

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters schema.

This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.